Add all missing docstrings and typing hints, improve docs, fix some but not all bugs #39

brainelectronics · 2022-12-17T16:34:48Z

Added

Typing hints available for all functions of umodbus, see Add typing hints #27
Docstrings available for all constants, functions and classes of umodbus, see Add typing hints #27
Test for reading more than 8 coils in a row to verify fix of Reading coils is limited to 8 bits #36
Test for reading single negative holding register value
Test for writing multiple coils to verify fix of Bug: error when trying to write multiple coils - host.write_multiple_coils() #22
Test for writing multiple registers to verify fix of Bug: error when trying to write multiple registers - host.write_multiple_registers() #23
Usage documentation for coil, discrete inputs, holding register and input register usage
Modbus TCP IP and port binding can be checked with is_bound property in tcp.py

Changed

Reordered modules of API documentation
data_as_registers and data_as_bits of common.py removed
Send illegal function code 0x01 if a register other than coil or holding register is requested to be set
Simplified _process_write_access logic of tcp.py

Fixed

Typing hints of function input parameters and return values
Response data of multiple changed registers (write_multiple_registers) is validated with respect to the provided signed flag in serial.py and tcp.py, see Bug: error when trying to write multiple registers - host.write_multiple_registers() #23
Enable reading more than 8 coils in a row, see Reading coils is limited to 8 bits #36
Writing multiple coils in TCP, see Bug: error when trying to write multiple coils - host.write_multiple_coils() #22
Writing multiple registers in TCP, see Bug: error when trying to write multiple registers - host.write_multiple_registers() #23

…ue signing in TCP and Serial modules, contribute to #23

…d valid

…n module

…ted way

brainelectronics · 2022-12-17T17:22:49Z

@beyonlo here are some new bugfixes for you to test in 2.1.0-rc15.dev39 😄 and some extended documentation for register usage as well https://micropython-modbus--39.org.readthedocs.build/en/39/USAGE.html#register-usage

beyonlo · 2022-12-18T22:07:35Z

Hi @brainelectronics Thank you for this new release!!

some extended documentation for register usage as well https://micropython-modbus--39.org.readthedocs.build/en/39/USAGE.html#register-usage

I liked so much the extended docs. I think is missing (as I commented in #24): The 0x05 write_single_coil talk about how to write single COIL just on the first position, but do not talk about how to write a COIL in a different position than the first one, like as the second position and so on.

Tests reports:

register_definitions = {
    "COILS": {
        "RESET_REGISTER_DATA_COIL": {
            "register": 42,
            "len": 1,
            "val": 0
        },
        "RESET_REGISTER_DATA_COIL_2": {
            "register": 45,
            "len": 1,
            "val": 1
        },
        "EXAMPLE_COIL": {
            "register": 123,
            "len": 16,
            "val": [1,0,0,1,1,0,1,1,1,1,1,1,1,1,0,1]
        },
        "EXAMPLE_COIL_MIXED": {
            "register": 124,
            "len": 3,
            "val": [1,1,1],
            "description": "Example COILS registers with length of 2, Coils (setter+getter) [0, 1]",
            "range": "",
            "unit": ""
        }
    },
    "HREGS": {
        "EXAMPLE_HREG": {
            "register": 93,
            "len": 1,
            "val": 19
        },
        "ANOTHER_EXAMPLE_HREG": {
            "register": 94,
            "len": 9,
            "val": [29, 38, 0, 1600, 2150, 5067, 2564, 8450, 3456],
            "description": "Example HREGS registers with length of 3, Hregs (setter+getter) [0, 65535]",
            "range": "",
            "unit": ""
        }
    },
    "ISTS": {
        "EXAMPLE_ISTS": {
            "register": 67,
            "len": 1,
            "val": 0
        }
    },
    "IREGS": {
        "EXAMPLE_IREG": {
            "register": 10,
            "len": 2,
            "val": 60001
        }
    }
}

Slave:

$ mpremote run tcp_client_example.py
Waiting for WiFi connection...
Waiting for WiFi connection...
Waiting for WiFi connection...
Connected to WiFi.
('192.168.1.4', '255.255.255.0', '192.168.1.1', '192.168.1.1')
Setting up registers ...
Register setup done
Running ModBus version: 2.1.0-rc15.dev39
Serving as TCP client on 192.168.1.4:502

"Enable reading more than 8 coils in a row, see Reading coils is limited to 8 bits #36"

Not fixed - still have errors, details below:

Master:

>>> from umodbus.tcp import TCP as ModbusTCPMaster
>>> host = ModbusTCPMaster(slave_ip='192.168.1.4', slave_port=502, timeout=5)
>>> from umodbus import version
>>> version.__version__
'2.1.0-rc15.dev39'
>>> host.read_coils(slave_addr=10, starting_addr=45, coil_qty=1)
[True] <---- OK
>>> host.read_coils(slave_addr=10, starting_addr=45, coil_qty=4)
[False, False, False, True] <---- OK
>>> host.read_coils(slave_addr=10, starting_addr=45, coil_qty=6)
[False, False, False, False, False, True] <---- OK
>>> host.read_coils(slave_addr=10, starting_addr=45, coil_qty=9)
[False, False, False, False, False, False, False, True] <---- NOT OK, coil_qty=9, but return just 8 COILS
>>> host.read_coils(slave_addr=10, starting_addr=45, coil_qty=16)
[False, False, False, False, False, False, False, True] <---- NOT OK, coil_qty=16, but return just 8 COILS
>>> host.read_coils(slave_addr=10, starting_addr=123, coil_qty=4) <---- NOT OK, Python error
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/lib/umodbus/tcp.py", line 364, in read_coils
  File "/lib/umodbus/functions.py", line 394, in bytes_to_bool
ValueError: invalid format specifier
>>> host.read_coils(slave_addr=10, starting_addr=123, coil_qty=1) <---- NOT OK, Python error
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/lib/umodbus/tcp.py", line 364, in read_coils
  File "/lib/umodbus/functions.py", line 394, in bytes_to_bool
ValueError: invalid format specifier
>>> host.read_coils(slave_addr=10, starting_addr=123, coil_qty=10) 
[True, False, False, True, True, False, True, True, True, True, True, True, True, True, False, True] <---- NOT OK, coil_qty=10, but return just 16 COILS
>>> host.read_coils(slave_addr=10, starting_addr=123, coil_qty=8) 
[True, False, False, True, True, False, True, True, True, True, True, True, True, True, False, True] <---- NOT OK, coil_qty=8, but return just 16 COILS
>>> 
>>> host.read_coils(slave_addr=10, starting_addr=124, coil_qty=1)
[True, True, True] <---- NOT OK, coil_qty=1, but return 3 COILS
>>> host.read_coils(slave_addr=10, starting_addr=124, coil_qty=8)
[False, False, False, False, False, True, True, True] <---- OK
>>> host.read_coils(slave_addr=10, starting_addr=124, coil_qty=16)
[False, False, False, False, False, True, True, True] <---- NOT OK, coil_qty=16, but return just 8 COILS
>>>

Writing multiple coils in TCP, see Bug: error when trying to write multiple coils - host.write_multiple_coils() #22

Works, but have some errors:

a) note about that before write multiple COILs, is reading from in normal way: from left to right from register definitions, but after is wrote, the read start inverse read, from right to left.
b) note that when write a list of COILs that with less COILs than in register_definitions, the other COILs is losted.

Master:

>>> host.read_coils(slave_addr=10, starting_addr=124, coil_qty=1)
[True, True, True] <-- read_coils quantity not works, but this test is about  writing multiple coils
>>> host.read_coils(slave_addr=10, starting_addr=124, coil_qty=8)
[False, False, False, False, False, True, True, True]
>>> host.write_multiple_coils(slave_addr=10, starting_address=124, output_values=[1,0])
True <--- OK - No errors
>>> host.read_coils(slave_addr=10, starting_addr=124, coil_qty=8)
[False, False, False, False, False, False, False, True] <--- wrote OK - but look that lost that third COIL that was true.
>>> 
>>> host.write_multiple_coils(slave_addr=10, starting_address=124, output_values=[1,0,1,1,1])
True <--- OK - No errors
>>> host.read_coils(slave_addr=10, starting_addr=124, coil_qty=1)
[True, True, True, False, True] <--- OK - Values changed to correct value!
>>> host.read_coils(slave_addr=10, starting_addr=123, coil_qty=1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/lib/umodbus/tcp.py", line 364, in read_coils
  File "/lib/umodbus/functions.py", line 394, in bytes_to_bool
ValueError: invalid format specifier
>>> 
>>> host.read_coils(slave_addr=10, starting_addr=123, coil_qty=16)
[True, False, False, True, True, False, True, True, True, True, True, True, True, True, False, True]
>>> host.write_multiple_coils(slave_addr=10, starting_address=123, output_values=[1,1,0,1,1,0,1,1,1,1,1,1,1,1,0,1])
True <--- OK - No errors
>>> host.read_coils(slave_addr=10, starting_addr=123, coil_qty=16)
[True, False, True, True, True, True, True, True, True, True, False, True, True, False, True, True] <--- OK - Values changed to correct value, but look that after wrote happen a time, starting to read from inverse list.

Writing multiple registers in TCP, see Bug: error when trying to write multiple registers - host.write_multiple_registers() #23

Master:
Works, but have some errors:

a) note that, like as happen with write_multiple_coils, writing multiple registers, when the list of registers that will write has less elements than in register_definitions, the all others registers is losted.

>>> host.read_holding_registers(slave_addr=10, starting_addr=94, register_qty=50, signed=False)
(29, 38, 0, 1600, 2150, 5067, 2564, 8450, 3456)
>>> host.write_multiple_registers(slave_addr=10, starting_address=94, register_values=[2, -4, 6, -256, 1024], signed=True)
True <--- OK wrote with sucess
>>> host.read_holding_registers(slave_addr=10, starting_addr=94, register_qty=50, signed=False)
(2, 65532, 6, 65280, 1024) <--- OK, but the registers 99, 100, 101 and 102 was losted
>>>

Good to see that functions 0x0F write_multiple_coils and 0x10 write_multiple_registers starting works! Still there are problems as reported above, but was a good start!

Thank you very much!

beyonlo · 2022-12-18T22:20:15Z

@brainelectronics more two things to report in this new version:

When I was to try to do that tests over ModBus RTU, happen this error:

$ mpremote run rtu_client_example.py
Running ModBus version: 2.1.0-rc15.dev39
Traceback (most recent call last):
  File "<stdin>", line 109, in <module>
AttributeError: 'ModbusRTU' object has no attribute 'process'

So, all tests above was done using only the ModBus TCP.

In this new version when I install using upip, it try to install micropython-urequests as well, but do not works. So, I continue to install like always done: using just urequests and works.

>>> upip.index_urls = ['https://test.pypi.org/pypi']
>>> upip.install('micropython-modbus')
Installing to: /lib/
Installing micropython-modbus 2.1.0rc15.dev39 from https://test-files.pythonhosted.org/packages/af/fe/4373dcec053064ed816ff5e4ce25dad7921e333a333a45ed863d085aac03/micropython-modbus-2.1.0rc15.dev39.tar.gz
Error installing 'micropython-urequests': Package not found, packages may be partially installed
>>>

brainelectronics

LGTM

brainelectronics · 2022-12-27T13:50:00Z

Hi @beyonlo, as discussed in #22 (comment) a COIL has a length of 1. If you define a COIL 98 with a length of 1, you can only set 98. If you define a length of 2 then coils 98+99 are configured. Due to bug #35 you can only set all coils you defined at once. But if you define a coil 98 with length 1 and another coil 99 with a length of 1 you can modify each coil without affecting any others by write singel coil function 0x05. But with this temporary trick you can not read 98+99 with read_coils(slave_addr=10, starting_addr=98, coil_qty=2) see also #15 (comment)

Regarding the not implemented fix of #36: yes see also #38

Missing Modbus RTU process function, bugfix is on the way

brainelectronics · 2022-12-27T14:52:27Z

Works, but have some errors:
a) note about that before write multiple COILs, is reading from in normal way: from left to right from register definitions, but after is wrote, the read start inverse read, from right to left.
b) note that when write a list of COILs that with less COILs than in register_definitions, the other COILs is losted.

Remarka will be fixed with #38, remark b will be fixed with #35

…butes to #35

…d discrete inputs partially, contributes to #35

beyonlo · 2022-12-28T05:51:58Z

@brainelectronics thank you very much for the clarifications! :)

brainelectronics added 29 commits December 16, 2022 14:50

add private functions to documentation, improve summary

3fa00ee

reorder API documentation modules

e81b68a

add doc strings and typing hints in common module, see #27

cb36e4f

add description to all constant modbus values

9beeda2

add docstrings and summary for modbus module, see also #27

ed0f82d

add doc strings and typing hints in serial module, see #27

ae6ef0f

add doc strings and typing hints in tcp module, see #27

0e315ac

validate reponse data of write_multiple_registers with respect to val…

745e939

…ue signing in TCP and Serial modules, contribute to #23

add doc strings and typing hints in functions module, see #27

c6c61cb

enable reading more than 8 coils in a row, fix #36

7e75392

add example coil definition with more than 8 coils to verify fix of #36

a0fde44

add test for reading more than 8 coils in a row to verify fix of #36

fabb9d9

add negative HREG value in example JSON

23e3280

add test for reading a negative holding register value

99f0c6d

fix writing multiple coils in TCP, resolve #22

16869a4

add test to verify write multiple coils fix #22, #38 is still open an…

0cbb444

…d valid

document usage of coil reading and writing, relates to #15 and #22

c5ccd28

document usage of discrete input reading

f0d06e1

comment unused common function data_as_registers

0b80c6a

fix writing multiple registers in TCP, resolve #23

9b0662b

add test to verify write multiple registers fix #23

75c1b7e

document usage of holding register reading and writing, relates to #23

dcb537c

add is_bound property to TCPServer class

ce220e1

document usage of input registers reading

d0b1415

simplify _process_write_access logic of TCP client

dd6deca

update changelog

072f5c2

remove not yet ready modbus register files, accidentially added

4ab4d1c

use MSB and LSB data properly in bytes_to_bool unit test, see #36

53c6694

remove unused functions data_as_bits and data_as_registers from commo…

debf453

…n module

brainelectronics added the bug Something isn't working label Dec 17, 2022

brainelectronics added the documentation Improvements or additions to documentation label Dec 17, 2022

brainelectronics added this to the Documentation milestone Dec 17, 2022

brainelectronics self-assigned this Dec 17, 2022

hightlight notes and warnings of Usage documentation in Sphinx suppor…

3e8a376

…ted way

brainelectronics commented Dec 27, 2022

View reviewed changes

brainelectronics added 3 commits December 27, 2022 15:57

return only requested amount of registers during read request, contri…

c1e51cb

…butes to #35

add unittest for reading coils, holding registers, input registers an…

9934dd3

…d discrete inputs partially, contributes to #35

update changelog and mention partial data request fix, see #35

b177204

brainelectronics modified the milestones: Documentation, Specification compliant Dec 27, 2022

brainelectronics merged commit 00f5916 into develop Dec 27, 2022

brainelectronics deleted the feature/add-all-missing-docstrings-and-typing-hints branch December 27, 2022 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add all missing docstrings and typing hints, improve docs, fix some but not all bugs #39

Add all missing docstrings and typing hints, improve docs, fix some but not all bugs #39

brainelectronics commented Dec 17, 2022

brainelectronics commented Dec 17, 2022

beyonlo commented Dec 18, 2022

beyonlo commented Dec 18, 2022

brainelectronics left a comment

brainelectronics commented Dec 27, 2022

brainelectronics commented Dec 27, 2022

beyonlo commented Dec 28, 2022

Add all missing docstrings and typing hints, improve docs, fix some but not all bugs #39

Add all missing docstrings and typing hints, improve docs, fix some but not all bugs #39

Conversation

brainelectronics commented Dec 17, 2022

Added

Changed

Fixed

brainelectronics commented Dec 17, 2022

beyonlo commented Dec 18, 2022

beyonlo commented Dec 18, 2022

brainelectronics left a comment

Choose a reason for hiding this comment

brainelectronics commented Dec 27, 2022

brainelectronics commented Dec 27, 2022

beyonlo commented Dec 28, 2022